Skip to content

Conversation

kamusta-msft
Copy link

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
  • A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
  • For guidance on SDK breaking change review, refer to https://aka.ms/ci-fix.

melina5656 and others added 30 commits August 21, 2025 14:45
…remove unnecessary decorators (Azure#36854)

* Change the position of the suppression

* Delete unnecessary decorators
* Updated documentation

* Changed 'country' to 'country/region'.

* Suppressing TypeSpec error.

---------

Co-authored-by: Faraz Siddiqui <124096851+FarazGIS@users.noreply.github.com>
Co-authored-by: Weidong Xu <weidxu@microsoft.com>
)

* Update typespec and add swagger JSON

* Add examples

* Update API version in examples

* Update data plane readme.md

* Add minValue and maxValue for loadPercentage

* Added CreatedByType updates and CreatedByUri properties

* Added CreatedByType updates and CreatedByUri properties

* Fix enum value

* Added clone test apis and equivalent LROs

* Missed uploading the swagger file

* Add insights in the test run result

* Examples and updates to operations apis

* Fixing the OperationSTatus LRO

* Revert "Add insights in the test run result"

This reverts commit d3d3672.

* Revert loadPercentage change for optional engine instance

* Add maximumVirtualUsersPerEngine auto stop parameter

* Add examples and added decorator

* tsv format and prettier

* Updated examples

* Updated example to contain headers

* Reverting a change

* Fixing a change

* Renaming operation

* LintDiff supressions

* Update client.tsp to latest

* Updated generation

* Add estimatedVirtualUserHours

* Add Read lifecycle

* Add testIds filter for ListTestRuns (Azure#35700)

* add testIds filter for ListTestRuns

* fix: update operationId for ListTestRuns to include TestIds

* fix: update title for ListTestRuns to reflect testIds filtering

* fix: update documentation for testIds in ListTestRunQueryParams to clarify usage

* Update examples

* Add testIds example

* Changes for actionable insights

* Adding specification for new ErrorDetail model (Azure#36532)

* fix tsp issues

* Move examples to right folder

* updated swagger failure

* update model

* PR comments

* add suppression

* Fixing OperationStatus Response body as per review comment

---------

Co-authored-by: Mitesh Shah <58204159+mitsha-microsoft@users.noreply.github.com>
Co-authored-by: Venkat Ragavan S <vens@microsoft.com>
Co-authored-by: mbhardwaj-msft <169130830+mbhardwaj-msft@users.noreply.github.com>
Co-authored-by: Himanshu Bisht <himanshubishtcse@gmail.com>
Co-authored-by: Venkat Ragavan <50309787+venkatr21@users.noreply.github.com>
Co-authored-by: Venkat Ragavan S <vens@microsoft.com>
)

* Fix wiql issue in getting release plan work items

* Update eng/common/scripts/Helpers/DevOps-WorkItem-Helpers.ps1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* .NET requires custom source path since source path contains dev tools repo

* Remove order by

---------

Co-authored-by: Praveen Kuttappan <praveen.kuttappan@gmail.com>
Co-authored-by: Praven Kuttappan <55455725+praveenkuttappan@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Mike Harder <mharder@microsoft.com>
Signed-off-by: trangevi <trangevi@microsoft.com>
Azure#36672)

* [OpenAI.v1] Temporarily removing deployment-based multipart-form-data operations.

* video.

* Fixing generate speech operation.

* finetuning.
* Unified Evaluation API Spec (Version upgrade)

* updating tspconfig.yaml

* Use flat scores

* Updating routes + Removing Agent run evaluation

* rename items to messages

* Updating InlineJsonDataSource to InlineDataSource

* Updating discriminator values

* initial modeling for real-time api evaluation (Azure#36147)

* initial modeling for real-time api: single evaluation

* update given comments

* add optional storage for customers

* remove plural

* updates given the SDK review

* remove the tsp generated json for merge ease

* OneEval is not a separate resource type

* remove additional storage option for sync. Clients will have to manage this

* Merge

* Update result model

* Fix example

* Adding standard deviation

* confidence interval

* Addressing feedback from API review

* nit fixing names

* Update to runBatch

* Readme update

* Example Added

* Fix examples

* Fix paths

* Revert older version changes

* Revert changes to older version

* Reverting more changes

* Adding Examples

* adding 2 MB limit

* Fix version in examples

* Added deprecated in route

* Adding comment

* Update name to id in new version of API

* Fix

* Model validation fixes

* EvaluationMessages -> EvaluatorMessages

* Fix model for labels

* Fixed examples for deprecated endpoints

* Removed deprecated routes

* Removed not needed files

* Correct Api-version in tspconfig.yaml

* Using OneEvaluation Model as request and response

* Remove state from individual result & put usage within metrics

* Update image url message type

* Removing request from response payload for OneEvaluation

* Fix example

* Mark API is deprecated

* Remove b64_json

* Fix image_url

* Adding error field as well in evaluator status

* Fix error message

* merge latest + fix tsp validation

* Fixed inline source to not return user data

* Fix the validation error

* Fix example

* Addressing PR comments - outcome union

* One -> Single rename

* Prettier fix

* Removing GetEvaluationResults API

* Fix lint issues

* prettier fix

---------

Co-authored-by: Ritesh Kumar Sinha <risinh@microsoft.com>
Co-authored-by: Kayla Seager <kayla.seager@microsoft.com>
Co-authored-by: Mike Harder <mharder@microsoft.com>
* delete old structure

* move to new structure

* files after tsp compile

* delete stragglers

* move under data plane

* update tspconfig path

* generated swagger

* update project root

* remove generated swaggers from data-plane level

* move readme up a level

* add readme

* point to right swagger

* changes

* reference swaggers

* update readme

* fix location

* location fix

* remove dupe readme
* init - bugfix

* add json

* examples

* pretty
…at (Azure#36032)

* Initial plan

* Convert security readme.python.md to singleapi package format

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
…ation (Azure#35937)

* Initial plan

* Convert web readme.python.md to single-api package configuration

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
…kage (Azure#36033)

* Initial plan

* Update compute readme.python.md to singleapi package format

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

* init for package-python-sdk

* update

* fix python tag

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
…Azure#36650)

* adding new stable 2025-08-02 version for the fist API. this will be the first GA API version

---------

Co-authored-by: Mike Lucadamo <mlucadamo@microsoft.com>
Co-authored-by: Scott Beddall <45376673+scbedd@users.noreply.github.com>
* update

* suppress lintDiff

* fix parameter name

* unflatten property bag

---------

Co-authored-by: Haider Agha <64601174+haagha@users.noreply.github.com>
…#36121)

* Adding Placement, MaxZoneCount and MaxInstancePercent

* Adding examples

* Restricting placement property to version 2025-04-01+

* Update field for maxInstancePercentPerZonePolicy

* Suppress BodyTopLevelProperties for VirtualMachineScaleSet to accommodate Placement

* Moving examples to tsp folder

* Adding reason in readme.md for BodyTopLevelProperty suppression

* Add upgradePolicy to example templates

* Update documentation of the Placement property

* Update documentation for Placement

---------

Co-authored-by: Haider Agha <64601174+haagha@users.noreply.github.com>
* bump oav dep to 4.0.0. This eliminates dependencies on newman and postman-collective

This reverts commit dc5e725.
Co-authored-by: Wes Haggard <Wes.Haggard@microsoft.com>
)

* Update package release status completion to process multiple packages

* Updated as per review comments

* Updated as per review comments

---------

Co-authored-by: Praveen Kuttappan <praveen.kuttappan@gmail.com>
Co-authored-by: Rena Chen <rechen@microsoft.com>
FumingZhang and others added 29 commits September 4, 2025 17:21
…iew/2025-07-02-preview (Azure#36779)

* Adds base for updating Microsoft.ContainerService/aks from version preview/2025-06-02-preview to version preview/2025-07-02-preview

* Updates readme

* Updates API version in new specs and examples

* [AKS] add AzureLinux3 ossku to preview (Azure#36337)

* feat: add AzureLinux3 ossku

* chore: update description

* [AKS] add structured authn to preview (Azure#36312)

* Add jwt authn paths, defs and parameters

* Add JWT examples

* Fix examples

* Fix create update example

* Fix another create or update example

* Fix lint

---------

Co-authored-by: Wei Chen <chewei@microsoft.com>

* AKS Blue Green Upgrades (Azure#36283)

* feat: update AP models for blue green upgrades

* feat: add path for Blue Green upgrade completion

* fix: remove 204 status code when completing blue/green ugprades

Addresses the following linter error:
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.

* chore: run prettier

* feat: add acns performance profile to advanced networking (Azure#36424)

* feat: add acns perf profile

* fix: run prettier

* fix: spelling

* fix: set default for acceleration mode to none (Azure#36528)

* feat: add acns perf profile

* fix: run prettier

* fix: spelling

* fix: add default for acceleration mode

* update (Azure#36539)

Co-authored-by: yingnizhou <yingnizhou@microsoft.com>
Co-authored-by: Scott Beddall <45376673+scbedd@users.noreply.github.com>

* update (Azure#37106)

* update (Azure#37107)

* update (Azure#37120)

* update (Azure#37121)

---------

Co-authored-by: lilypan26 <lilylpan0426@gmail.com>
Co-authored-by: Wei Chen <weichch87@gmail.com>
Co-authored-by: Wei Chen <chewei@microsoft.com>
Co-authored-by: Cuthbert <47732656+CustardTart32@users.noreply.github.com>
Co-authored-by: Santhosh  Prabhu <6684582+santhoshmprabhu@users.noreply.github.com>
Co-authored-by: Jenniferyingni <Jennyingni@gmail.com>
Co-authored-by: yingnizhou <yingnizhou@microsoft.com>
Co-authored-by: Scott Beddall <45376673+scbedd@users.noreply.github.com>
Co-authored-by: Ray Chen <raychen@microsoft.com>
* convert

* WIP

* .

* Draft to convert msi

* fix example

* update

* WIP

* Fix warning

* upate emitter option

* preittier

* ???

* update subid sample

* format

* remove comments

* update example

* update example

* update tspconfig

* update tspconfig

* update exmaple

* update tspconfig

* update example

* add fixme

* .

* .

* update scope

* remove extra files

* update scope

* scope

* id

* revert old examples

* remove sparse-spec

* resolve breaking

* java config

* format

* remove readOnly on properties

* fix pageitems issue

* fix comments

* fix comments

* remove suppression

* update

* update

* Update tspconfig.yaml for Java

* format

---------

Co-authored-by: mcgallan <1186003288@qq.com>
Co-authored-by: Jiao Di (MSFT) <80496810+v-jiaodi@users.noreply.github.com>
Co-authored-by: XiaofeiCao <xiaofeicao@microsoft.com>
Co-authored-by: mcgallan <88413158+mcgallan@users.noreply.github.com>
Co-authored-by: Pan Shao <pashao@microsoft.com>
Co-authored-by: Xiaofei Cao <92354331+XiaofeiCao@users.noreply.github.com>
…7063)

* java update doc/sample for emitter-output-dir

* remove java package-dir validation

* add rule for emitter-output-dir for java, this option can be undefined

* update emitter-output-dir

* fix duplicate emitter-output-dir

* fix mission

* fix edge.configurations

* Update tspconfig.yaml
Co-authored-by: Shane Zou <xinzo@microsoft.com>
* refactor structure folder

* fix ci errors
…37006)

* refactor structure folder

* update path in specification/suppressions.yaml file
)

* Refactor mongocluster folder structure to comply with Azure Guidelines

* update

* Update mongoCluster.json

---------

Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
* refactor structure folder

* fix ci errors
…re#36849)

* Refactor sqlvirtualmachine folder structure to comply with Azure Guidelines

* Update the relevant paths in cspell.yaml file
…e#36728)

* refactor-folder-structure

* Remove tspconfig.yaml.backup

* Update the relevant paths in cspell.yaml file
Azure#36902)

* Refactor hardwaresecuritymodules folder structure to comply with Azure Guidelines

* Update tspconfig.yaml
…re#36729)

* refactor

* update path for all TrafficController.json file to fix ci error

* add example files for 2022-10-01-preview about ServiceNetworking

* fix prettier ci error

---------

Co-authored-by: User <user@example.com>
Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
…e#36945)

* Refactor appconfiguration folder structure to comply with Azure Guidelines

* Updated specification/suppressions.yaml file

* fix ci error

* Remove restler/annotations.json file

* Add supression.yaml
* Refactor app folder structure to comply with Azure Guidelines

* Update specification/suppressions.yaml

* Update readme.md
* Refactor translation folder structure to comply with Azure Guidelines

* Update specification/suppressions.yaml

* Update stable/v3.0 => stable/3.0

---------

Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
* refactor structure folder

* fix ci errors

* fix conflict
…e#36813)

* refactor structure folder

* fix ci errors

* fix output-file path to fix ci error
* refactor: Restructure FileShares folder to align with Azure API Guidelines

* Update fileshares.json

* Remove the suppressions.yaml file
)

* Add a script to update pull request URL in release plan from SDK generation pipeline
This is a very small fix to the readme file that blocks other PR to be merge 
Please review and approve
@github-actions
Copy link

github-actions bot commented Sep 9, 2025

Next Steps to Merge

Important checks have failed. As of today they are not blocking this PR, but in near future they may.
Addressing the following failures is highly recommended:
  • ⚠️ The check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.


Comment generated by summarize-checks workflow run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.